[DOCS-466] Standardize docs about creating API keys and signing in #1054
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Update each integration to use the same headings and structure - Fix other section headings in the integrations - Use the same details in the public API guide - Use the same details in the quickstart
mdlinville
requested review from
ngrayluna
and removed request for
chrishiste
Deploying docs with
|
| Latest commit: |
36231e3
|
| Status: | ⚡️ Build in progress... |
ngrayluna
requested changes
Jan 31, 2025
ngrayluna
approved these changes
Feb 3, 2025
johndmulhausen
pushed a commit
that referenced
this pull request
Feb 19, 2025
…1054) [DOCS-466] Standardize docs about creating API keys and signing in - Update each integration to use the same headings and structure - Fix other section headings in the integrations - Use the same details in the public API guide - Use the same details in the quickstart - Add non-notebook Python examples - Update references to "Weights & Biases" to "W&B"
johndmulhausen
pushed a commit
that referenced
this pull request
Feb 21, 2025
…1054) [DOCS-466] Standardize docs about creating API keys and signing in - Update each integration to use the same headings and structure - Fix other section headings in the integrations - Use the same details in the public API guide - Use the same details in the quickstart - Add non-notebook Python examples - Update references to "Weights & Biases" to "W&B"
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
DOCS-466 Standardize docs about creating API keys and signing in
The original request asked for a dedicated page with these details, and to point the integrations at that page. That's not ideal because they need to go read that page and then come back to the integration page. Ideally that "Create an API key" page would be a sibling to the Quickstart, but I think it would actually look quite strange. See the left hand when you are viewing https://docs.wandb.ai/quickstart/ to see what I mean.
Ideally I could save this content to one or two includes which could then be included by each of the integrations, but I ran into issues with caching and with Docsy shortcodes not being evaluated within the includes. So this uses a more brute force approach for now.